<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>google.SearchResultsMetaData</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">

<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="google-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://pygoogle.sf.net">PyGoogle</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <font size="-1"><b class="breadcrumbs">
        <a href="google-module.html">Module&nbsp;google</a> ::
        Class&nbsp;SearchResultsMetaData
      </b></font></br>
    </td>
    <td><table cellpadding="0" cellspacing="0">
      <tr><td align="right"><font size="-2">[<a href="../private/google.SearchResultsMetaData-class.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="google.SearchResultsMetaData-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class SearchResultsMetaData</h2>

<pre class="base-tree">
<a href="../private/google._SearchBase-class.html"><code>_SearchBase</code></a> --+
              |
             <b>SearchResultsMetaData</b>
</pre><br />

<hr/>

Container class for metadata about a given search query's results.
<hr/>


<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#directoryCategories"><code>directoryCategories</code></a></b>: list of categories for the search results</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#documentFiltering"><code>documentFiltering</code></a></b>: is duplicate page filtering active?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#endIndex"><code>endIndex</code></a></b>: index of the last result returned (zero-based)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#estimatedTotalResultsCount"><code>estimatedTotalResultsCount</code></a></b>: estimated total number of results for this query.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#estimateIsExact"><code>estimateIsExact</code></a></b>: is estimatedTotalResultsCount an exact value?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#searchComments"><code>searchComments</code></a></b>: human-readable informational message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#searchQuery"><code>searchQuery</code></a></b>: search string that initiated this search</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#searchTime"><code>searchTime</code></a></b>: total search time, in seconds</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#searchTips"><code>searchTips</code></a></b>: human-readable informational message on how to better use Google.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
<td><b><a href="google.SearchResultsMetaData-class.html#startIndex"><code>startIndex</code></a></b>: index of the first result returned (zero-based)</td></tr>
</table><br />


<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="directoryCategories"></a>
<h3>directoryCategories</h3>
<p>list of categories for the search results</p>
This field is a list of dictionaries, like so:
<pre class="literalblock">
   { 'fullViewableName': 'the Open Directory category',
     'specialEncoding':  'encoding scheme of this directory category'
   }
</pre>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="documentFiltering"></a>
<h3>documentFiltering</h3>
is duplicate page filtering active?
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="endIndex"></a>
<h3>endIndex</h3>
index of the last result returned (zero-based)
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="estimatedTotalResultsCount"></a>
<h3>estimatedTotalResultsCount</h3>
estimated total number of results for this query.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="estimateIsExact"></a>
<h3>estimateIsExact</h3>
is estimatedTotalResultsCount an exact value?
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="searchComments"></a>
<h3>searchComments</h3>
<p>human-readable informational message</p>
example:
<pre class="literalblock">
    &quot;'the' is a very common word and was not included in your search&quot;
</pre>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="searchQuery"></a>
<h3>searchQuery</h3>
search string that initiated this search
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="searchTime"></a>
<h3>searchTime</h3>
total search time, in seconds
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="searchTips"></a>
<h3>searchTips</h3>
human-readable informational message on how to better use Google.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="startIndex"></a>
<h3>startIndex</h3>
index of the first result returned (zero-based)
</td></tr></table>
<br />


<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="google-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://pygoogle.sf.net">PyGoogle</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
  <tr>
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Wed Feb 25 18:54:21 2004</font></td>
    <td align="right"><a href="http://epydoc.sourceforge.net"
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
  </tr>
</table>
</body>
</html>
